<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a name="line.1"></a>
<span class="sourceLineNo">002</span>/*<a name="line.2"></a>
<span class="sourceLineNo">003</span> * Copyright (C) 2011 Archie L. Cobbs. All rights reserved.<a name="line.3"></a>
<span class="sourceLineNo">004</span> *<a name="line.4"></a>
<span class="sourceLineNo">005</span> * $Id: VaadinApplicationListener.html 883 2014-05-07 02:45:34Z archie.cobbs $<a name="line.5"></a>
<span class="sourceLineNo">006</span> */<a name="line.6"></a>
<span class="sourceLineNo">007</span><a name="line.7"></a>
<span class="sourceLineNo">008</span>package org.dellroad.stuff.vaadin7;<a name="line.8"></a>
<span class="sourceLineNo">009</span><a name="line.9"></a>
<span class="sourceLineNo">010</span>import com.vaadin.server.VaadinSession;<a name="line.10"></a>
<span class="sourceLineNo">011</span><a name="line.11"></a>
<span class="sourceLineNo">012</span>import org.springframework.context.ApplicationEvent;<a name="line.12"></a>
<span class="sourceLineNo">013</span>import org.springframework.context.ApplicationListener;<a name="line.13"></a>
<span class="sourceLineNo">014</span>import org.springframework.context.event.ApplicationEventMulticaster;<a name="line.14"></a>
<span class="sourceLineNo">015</span><a name="line.15"></a>
<span class="sourceLineNo">016</span>/**<a name="line.16"></a>
<span class="sourceLineNo">017</span> * A Spring {@link org.springframework.context.ApplicationListener} support superclass customized for use by<a name="line.17"></a>
<span class="sourceLineNo">018</span> * listeners that are part of a Vaadin application when listening to non-Vaadin application event sources.<a name="line.18"></a>
<span class="sourceLineNo">019</span> *<a name="line.19"></a>
<span class="sourceLineNo">020</span> * &lt;p&gt;<a name="line.20"></a>
<span class="sourceLineNo">021</span> * Listeners that are part of a Vaadin application should use this superclass if they are going to be registered<a name="line.21"></a>
<span class="sourceLineNo">022</span> * with non-Vaadin event sources. This will ensure that events are delivered in the proper Vaadin application context<a name="line.22"></a>
<span class="sourceLineNo">023</span> * and memory leaks are avoided when the session closes.<a name="line.23"></a>
<span class="sourceLineNo">024</span> * &lt;/p&gt;<a name="line.24"></a>
<span class="sourceLineNo">025</span> *<a name="line.25"></a>
<span class="sourceLineNo">026</span> * @param &lt;E&gt; The type of the event<a name="line.26"></a>
<span class="sourceLineNo">027</span> * @see VaadinExternalListener<a name="line.27"></a>
<span class="sourceLineNo">028</span> * @see VaadinUtil#invoke<a name="line.28"></a>
<span class="sourceLineNo">029</span> * @see VaadinApplicationScope<a name="line.29"></a>
<span class="sourceLineNo">030</span> * @see SpringVaadinSessionListener<a name="line.30"></a>
<span class="sourceLineNo">031</span> */<a name="line.31"></a>
<span class="sourceLineNo">032</span>public abstract class VaadinApplicationListener&lt;E extends ApplicationEvent&gt;<a name="line.32"></a>
<span class="sourceLineNo">033</span>  extends VaadinExternalListener&lt;ApplicationEventMulticaster&gt; implements ApplicationListener&lt;E&gt; {<a name="line.33"></a>
<span class="sourceLineNo">034</span><a name="line.34"></a>
<span class="sourceLineNo">035</span>    /**<a name="line.35"></a>
<span class="sourceLineNo">036</span>     * Convenience constructor. Equivalent to:<a name="line.36"></a>
<span class="sourceLineNo">037</span>     * &lt;blockquote&gt;<a name="line.37"></a>
<span class="sourceLineNo">038</span>     *  {@link #VaadinApplicationListener(ApplicationEventMulticaster, VaadinSession)<a name="line.38"></a>
<span class="sourceLineNo">039</span>     *      VaadinApplicationListener(multicaster, VaadinUtil.getCurrentSession())}<a name="line.39"></a>
<span class="sourceLineNo">040</span>     * &lt;/blockquote&gt;<a name="line.40"></a>
<span class="sourceLineNo">041</span>     *<a name="line.41"></a>
<span class="sourceLineNo">042</span>     * @param multicaster the application event multicaster on which this listener will register<a name="line.42"></a>
<span class="sourceLineNo">043</span>     * @throws IllegalArgumentException if {@code multicaster} is null<a name="line.43"></a>
<span class="sourceLineNo">044</span>     * @throws IllegalArgumentException if there is no {@link VaadinSession} associated with the current thread<a name="line.44"></a>
<span class="sourceLineNo">045</span>     */<a name="line.45"></a>
<span class="sourceLineNo">046</span>    public VaadinApplicationListener(ApplicationEventMulticaster multicaster) {<a name="line.46"></a>
<span class="sourceLineNo">047</span>        this(multicaster, VaadinUtil.getCurrentSession());<a name="line.47"></a>
<span class="sourceLineNo">048</span>    }<a name="line.48"></a>
<span class="sourceLineNo">049</span><a name="line.49"></a>
<span class="sourceLineNo">050</span>    /**<a name="line.50"></a>
<span class="sourceLineNo">051</span>     * Primary constructor.<a name="line.51"></a>
<span class="sourceLineNo">052</span>     *<a name="line.52"></a>
<span class="sourceLineNo">053</span>     * @param multicaster the application event multicaster on which this listener will register<a name="line.53"></a>
<span class="sourceLineNo">054</span>     * @param session the associated Vaadin application<a name="line.54"></a>
<span class="sourceLineNo">055</span>     * @throws IllegalArgumentException if either parameter is null<a name="line.55"></a>
<span class="sourceLineNo">056</span>     */<a name="line.56"></a>
<span class="sourceLineNo">057</span>    public VaadinApplicationListener(ApplicationEventMulticaster multicaster, VaadinSession session) {<a name="line.57"></a>
<span class="sourceLineNo">058</span>        super(multicaster, session);<a name="line.58"></a>
<span class="sourceLineNo">059</span>    }<a name="line.59"></a>
<span class="sourceLineNo">060</span><a name="line.60"></a>
<span class="sourceLineNo">061</span>    @Override<a name="line.61"></a>
<span class="sourceLineNo">062</span>    protected void register(ApplicationEventMulticaster multicaster) {<a name="line.62"></a>
<span class="sourceLineNo">063</span>        multicaster.addApplicationListener(this);<a name="line.63"></a>
<span class="sourceLineNo">064</span>    }<a name="line.64"></a>
<span class="sourceLineNo">065</span><a name="line.65"></a>
<span class="sourceLineNo">066</span>    @Override<a name="line.66"></a>
<span class="sourceLineNo">067</span>    protected void unregister(ApplicationEventMulticaster multicaster) {<a name="line.67"></a>
<span class="sourceLineNo">068</span>        multicaster.removeApplicationListener(this);<a name="line.68"></a>
<span class="sourceLineNo">069</span>    }<a name="line.69"></a>
<span class="sourceLineNo">070</span><a name="line.70"></a>
<span class="sourceLineNo">071</span>    @Override<a name="line.71"></a>
<span class="sourceLineNo">072</span>    public final void onApplicationEvent(final E event) {<a name="line.72"></a>
<span class="sourceLineNo">073</span>        this.handleEvent(new Runnable() {<a name="line.73"></a>
<span class="sourceLineNo">074</span>            @Override<a name="line.74"></a>
<span class="sourceLineNo">075</span>            public void run() {<a name="line.75"></a>
<span class="sourceLineNo">076</span>                VaadinApplicationListener.this.onApplicationEventInternal(event);<a name="line.76"></a>
<span class="sourceLineNo">077</span>            }<a name="line.77"></a>
<span class="sourceLineNo">078</span>        });<a name="line.78"></a>
<span class="sourceLineNo">079</span>    }<a name="line.79"></a>
<span class="sourceLineNo">080</span><a name="line.80"></a>
<span class="sourceLineNo">081</span>    /**<a name="line.81"></a>
<span class="sourceLineNo">082</span>     * Handle a listener event. When this method is invoked, it will already be within the context<a name="line.82"></a>
<span class="sourceLineNo">083</span>     * of the {@link VaadinSession} with which this listener is associated.<a name="line.83"></a>
<span class="sourceLineNo">084</span>     *<a name="line.84"></a>
<span class="sourceLineNo">085</span>     * @see VaadinUtil#invoke<a name="line.85"></a>
<span class="sourceLineNo">086</span>     * @see VaadinUtil#getCurrentSession<a name="line.86"></a>
<span class="sourceLineNo">087</span>     */<a name="line.87"></a>
<span class="sourceLineNo">088</span>    protected abstract void onApplicationEventInternal(E event);<a name="line.88"></a>
<span class="sourceLineNo">089</span>}<a name="line.89"></a>
<span class="sourceLineNo">090</span><a name="line.90"></a>




























































</pre>
</div>
</body>
</html>
